docs: Fix flutter side name confusion#384
Conversation
Updated import statement for user ID retrieval example.
The "client" keyword is confusing because there is actually a client in the serverpod, so it's better to keep the same name across all docs
Updated references from 'App' to 'Flutter app' for clarity.
xM1haix
changed the title
xM1haix
changed the title
xM1haix
changed the title
SandPod
left a comment
SandPod
left a comment
There was a problem hiding this comment.
This is a good clarification, could you make this change to all 3.x.x versions of the documentation along with the non versioned docs?
The non-versioned docs is required to preserve this change when we create new versions of the documentation.
|
Thank you! Yes, I will work on it! |
…ve clarity - Updated references from "client" to "Flutter app" across multiple documents to enhance consistency and clarity. - Revised sections on endpoint creation, error handling, pagination, caching, and authentication to reflect the Flutter context. - Improved explanations regarding server interactions, emphasizing the role of the Flutter app in various scenarios. - Enhanced descriptions of streaming methods and file uploads to align with Flutter app usage. - Clarified security configuration instructions specific to Flutter apps.
…larity - Changed references from "client" to "Flutter app" in various sections to enhance understanding for Flutter developers. - Updated examples and explanations to specify interactions from the Flutter app perspective. - Clarified error handling and exception management processes in the context of Flutter. - Adjusted pagination, caching, and streaming documentation to align with Flutter app usage. - Enhanced module and security configuration sections to include Flutter-specific instructions.
…sion 3.2.0 to use the correct terminology.
…sion 3.2.0 to use the correct terminology.
…e-endpoint-inheritance
|
I'm back (a bit late, it's been a tough month) with the changes I made, please if you can double-check if everything is correct and let me know if there's anything else I need to do. |
|
Thank you, @xM1haix. We decided to include the fix for the auth import. The renamings we will leave out for now. The import fix has been applied across all affected versions (3.0.0–3.4.0 and current docs) in #605, with you credited as co-author. Thank you for the effort you put into this, and for your patience waiting for a response. We hope to see you contribute again! |
3 participants
Keeping the same name across all docs will lead to less confusion.